2.1 新增本地用户
Path: /api/v2/localUser/createUser
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
- 参数groupID所属组ID,必须参数,根组ID为'root'。如果需要将用户关联到其他组织架构,可先用组织架构的查询接口(queryGroupByPath)获取ID。
对于参数password,为了保障数据传输过程中(数据从浏览器/客户端到服务端的过程)密码数据的安全,强烈建议使用RSA算法对密码字段进行加密(将pwdModel参数设置为'rsa')。加密方式参考《使用说明文档》附录。如果您不想对密码字段进行加密(不建议),可以不传pwdModel参数或者将pwdModel参数设置为'clear'。
认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
- 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | 用户名 | ||
password | string | 必须 | 密码 | 如果使用'rsa'密码模式,需要对密码进行加密 | |
groupId | string | 必须 | 所属组ID | 根组ID为'root' | |
displayName | string | 非必须 | 显示名 | ||
externalId | string | 非必须 | 外部ID | ||
inheritGroup | number | 非必须 | 1 | 继承所属组的应用授权:0不继承,1继承 | |
status | number | 非必须 | 1 | 启用状态:0禁用,1启用 | |
description | string | 非必须 | 描述 | ||
phone | string | 非必须 | 手机号码 | ||
string | 非必须 | 电子邮件 | |||
expiredTime | string | 非必须 | "0" | 过期时间,13位长度的Unix时间戳,'0'表示永不过期 | |
authComposeId | string | >2.2.5:非必须 <=2.2.5:必须 |
认证策略ID | >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <=2.2.5:必须传策略ID |
|
userPolicyId | string | 非必须 | 用户策略ID | >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <=2.2.5:不支持传空字符串,不传为默认策略 |
|
pwdModel | string | 非必须 | 'clear' | 密码加密算法类型:'clear'明文,'rsa'非对称加密 | 强烈建议使用'rsa' |
roleIdList | string[] | 非必须 | 角色ID数组 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
roleNameList | string[] | 非必须 | 角色名称数组 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 |
请求示例
{
"status": 1,
"name": "testUser",
"description": "",
"password": "]t4V9J1b",
"email": "",
"phone": "",
"groupId": "root",
"expiredTime": "0",
"inheritGroup": 1,
"roleIdList": ["23c916f0-5583-11eb-880a-913383f106f2"]
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 返回码,0 返回成功 | ||
data | string[] | 必须 | 用户ID | ||
msg | string | 必须 | 返回提示信息,与返回码对应 |
返回示例
{
"code": 0,
"data":["574229e0-d19c-11ec-b981-25f35dfc3047"],
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
用户显示名不能超过128字符 | 7201 |
外部ID长度不能超过128字符 | 7201 |
密码长度必须为6到128位 | 7201 |
用户或组织架构最多关联1000个应用 | 10000000 |
密码不能属于常见弱密码 | 10000001 |
外部ID重复,请重新输入 | 10000000 |
密码不能包含用户名 | 10000000 |
用户名(%s)已存在 | 77200005 |
组织架构不存在 | 77200004 |
认证策略不存在 | 77200004 |
用户策略不存在 | 77200004 |
角色不存在或已被删除 | 77200004 |
保存失败,关联的应用不存在或已被删除 | 77200004 |